3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use Liuggio\StatsdClient\Sender\SocketSender
;
28 use MediaWiki\Logger\LoggerFactory
;
29 use MediaWiki\Session\SessionManager
;
30 use MediaWiki\MediaWikiServices
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Rdbms\DBReplicationWaitError
;
34 // Hide compatibility functions from Doxygen
37 * Compatibility functions
39 * We support PHP 5.5.9 and up.
40 * Re-implementations of newer functions or functions in non-standard
41 * PHP extensions may be included here.
44 // hash_equals function only exists in PHP >= 5.6.0
45 // https://secure.php.net/hash_equals
46 if ( !function_exists( 'hash_equals' ) ) {
48 * Check whether a user-provided string is equal to a fixed-length secret string
49 * without revealing bytes of the secret string through timing differences.
51 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
52 * function in C) is to compare corresponding bytes and stop at the first difference,
53 * which would take longer for a partial match than for a complete mismatch. This
54 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
55 * and the other may come from an attacker. Statistical analysis of timing measurements
56 * over many requests may allow the attacker to guess the string's bytes one at a time
57 * (and check his guesses) even if the timing differences are extremely small.
59 * When making such a security-sensitive comparison, it is essential that the sequence
60 * in which instructions are executed and memory locations are accessed not depend on
61 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
62 * the inevitable leakage of the string's length. That is generally known anyway as
63 * a chararacteristic of the hash function used to compute the secret value.
65 * Longer explanation: http://www.emerose.com/timing-attacks-explained
68 * @param string $known_string Fixed-length secret string to compare against
69 * @param string $user_string User-provided string
70 * @return bool True if the strings are the same, false otherwise
72 function hash_equals( $known_string, $user_string ) {
73 // Strict type checking as in PHP's native implementation
74 if ( !is_string( $known_string ) ) {
75 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
76 gettype( $known_string ) . ' given', E_USER_WARNING
);
81 if ( !is_string( $user_string ) ) {
82 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
83 gettype( $user_string ) . ' given', E_USER_WARNING
);
88 $known_string_len = strlen( $known_string );
89 if ( $known_string_len !== strlen( $user_string ) ) {
94 for ( $i = 0; $i < $known_string_len; $i++
) {
95 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
98 return ( $result === 0 );
106 * This queues an extension to be loaded through
107 * the ExtensionRegistry system.
109 * @param string $ext Name of the extension to load
110 * @param string|null $path Absolute path of where to find the extension.json file
113 function wfLoadExtension( $ext, $path = null ) {
115 global $wgExtensionDirectory;
116 $path = "$wgExtensionDirectory/$ext/extension.json";
118 ExtensionRegistry
::getInstance()->queue( $path );
122 * Load multiple extensions at once
124 * Same as wfLoadExtension, but more efficient if you
125 * are loading multiple extensions.
127 * If you want to specify custom paths, you should interact with
128 * ExtensionRegistry directly.
130 * @see wfLoadExtension
131 * @param string[] $exts Array of extension names to load
134 function wfLoadExtensions( array $exts ) {
135 global $wgExtensionDirectory;
136 $registry = ExtensionRegistry
::getInstance();
137 foreach ( $exts as $ext ) {
138 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
145 * @see wfLoadExtension
146 * @param string $skin Name of the extension to load
147 * @param string|null $path Absolute path of where to find the skin.json file
150 function wfLoadSkin( $skin, $path = null ) {
152 global $wgStyleDirectory;
153 $path = "$wgStyleDirectory/$skin/skin.json";
155 ExtensionRegistry
::getInstance()->queue( $path );
159 * Load multiple skins at once
161 * @see wfLoadExtensions
162 * @param string[] $skins Array of extension names to load
165 function wfLoadSkins( array $skins ) {
166 global $wgStyleDirectory;
167 $registry = ExtensionRegistry
::getInstance();
168 foreach ( $skins as $skin ) {
169 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
174 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
179 function wfArrayDiff2( $a, $b ) {
180 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
184 * @param array|string $a
185 * @param array|string $b
188 function wfArrayDiff2_cmp( $a, $b ) {
189 if ( is_string( $a ) && is_string( $b ) ) {
190 return strcmp( $a, $b );
191 } elseif ( count( $a ) !== count( $b ) ) {
192 return count( $a ) < count( $b ) ?
-1 : 1;
196 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
197 $cmp = strcmp( $valueA, $valueB );
207 * Appends to second array if $value differs from that in $default
209 * @param string|int $key
210 * @param mixed $value
211 * @param mixed $default
212 * @param array $changed Array to alter
213 * @throws MWException
215 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
216 if ( is_null( $changed ) ) {
217 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
219 if ( $default[$key] !== $value ) {
220 $changed[$key] = $value;
225 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
227 * wfMergeErrorArrays(
240 * @param array $array1,...
243 function wfMergeErrorArrays( /*...*/ ) {
244 $args = func_get_args();
246 foreach ( $args as $errors ) {
247 foreach ( $errors as $params ) {
248 $originalParams = $params;
249 if ( $params[0] instanceof MessageSpecifier
) {
251 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
253 # @todo FIXME: Sometimes get nested arrays for $params,
254 # which leads to E_NOTICEs
255 $spec = implode( "\t", $params );
256 $out[$spec] = $originalParams;
259 return array_values( $out );
263 * Insert array into another array after the specified *KEY*
265 * @param array $array The array.
266 * @param array $insert The array to insert.
267 * @param mixed $after The key to insert after
270 function wfArrayInsertAfter( array $array, array $insert, $after ) {
271 // Find the offset of the element to insert after.
272 $keys = array_keys( $array );
273 $offsetByKey = array_flip( $keys );
275 $offset = $offsetByKey[$after];
277 // Insert at the specified offset
278 $before = array_slice( $array, 0, $offset +
1, true );
279 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
281 $output = $before +
$insert +
$after;
287 * Recursively converts the parameter (an object) to an array with the same data
289 * @param object|array $objOrArray
290 * @param bool $recursive
293 function wfObjectToArray( $objOrArray, $recursive = true ) {
295 if ( is_object( $objOrArray ) ) {
296 $objOrArray = get_object_vars( $objOrArray );
298 foreach ( $objOrArray as $key => $value ) {
299 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
300 $value = wfObjectToArray( $value );
303 $array[$key] = $value;
310 * Get a random decimal value between 0 and 1, in a way
311 * not likely to give duplicate values for any realistic
312 * number of articles.
314 * @note This is designed for use in relation to Special:RandomPage
315 * and the page_random database field.
319 function wfRandom() {
320 // The maximum random value is "only" 2^31-1, so get two random
321 // values to reduce the chance of dupes
322 $max = mt_getrandmax() +
1;
323 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
328 * Get a random string containing a number of pseudo-random hex characters.
330 * @note This is not secure, if you are trying to generate some sort
331 * of token please use MWCryptRand instead.
333 * @param int $length The length of the string to generate
337 function wfRandomString( $length = 32 ) {
339 for ( $n = 0; $n < $length; $n +
= 7 ) {
340 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
342 return substr( $str, 0, $length );
346 * We want some things to be included as literal characters in our title URLs
347 * for prettiness, which urlencode encodes by default. According to RFC 1738,
348 * all of the following should be safe:
352 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
353 * character which should not be encoded. More importantly, google chrome
354 * always converts %7E back to ~, and converting it in this function can
355 * cause a redirect loop (T105265).
357 * But + is not safe because it's used to indicate a space; &= are only safe in
358 * paths and not in queries (and we don't distinguish here); ' seems kind of
359 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
360 * is reserved, we don't care. So the list we unescape is:
364 * However, IIS7 redirects fail when the url contains a colon (see T24709),
365 * so no fancy : for IIS7.
367 * %2F in the page titles seems to fatally break for some reason.
372 function wfUrlencode( $s ) {
375 if ( is_null( $s ) ) {
380 if ( is_null( $needle ) ) {
381 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
382 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
383 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
389 $s = urlencode( $s );
392 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
400 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
401 * "days=7&limit=100". Options in the first array override options in the second.
402 * Options set to null or false will not be output.
404 * @param array $array1 ( String|Array )
405 * @param array|null $array2 ( String|Array )
406 * @param string $prefix
409 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
410 if ( !is_null( $array2 ) ) {
411 $array1 = $array1 +
$array2;
415 foreach ( $array1 as $key => $value ) {
416 if ( !is_null( $value ) && $value !== false ) {
420 if ( $prefix !== '' ) {
421 $key = $prefix . "[$key]";
423 if ( is_array( $value ) ) {
425 foreach ( $value as $k => $v ) {
426 $cgi .= $firstTime ?
'' : '&';
427 if ( is_array( $v ) ) {
428 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
430 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
435 if ( is_object( $value ) ) {
436 $value = $value->__toString();
438 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
446 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
447 * its argument and returns the same string in array form. This allows compatibility
448 * with legacy functions that accept raw query strings instead of nice
449 * arrays. Of course, keys and values are urldecode()d.
451 * @param string $query Query string
452 * @return string[] Array version of input
454 function wfCgiToArray( $query ) {
455 if ( isset( $query[0] ) && $query[0] == '?' ) {
456 $query = substr( $query, 1 );
458 $bits = explode( '&', $query );
460 foreach ( $bits as $bit ) {
464 if ( strpos( $bit, '=' ) === false ) {
465 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
469 list( $key, $value ) = explode( '=', $bit );
471 $key = urldecode( $key );
472 $value = urldecode( $value );
473 if ( strpos( $key, '[' ) !== false ) {
474 $keys = array_reverse( explode( '[', $key ) );
475 $key = array_pop( $keys );
477 foreach ( $keys as $k ) {
478 $k = substr( $k, 0, -1 );
479 $temp = [ $k => $temp ];
481 if ( isset( $ret[$key] ) ) {
482 $ret[$key] = array_merge( $ret[$key], $temp );
494 * Append a query string to an existing URL, which may or may not already
495 * have query string parameters already. If so, they will be combined.
498 * @param string|string[] $query String or associative array
501 function wfAppendQuery( $url, $query ) {
502 if ( is_array( $query ) ) {
503 $query = wfArrayToCgi( $query );
505 if ( $query != '' ) {
506 // Remove the fragment, if there is one
508 $hashPos = strpos( $url, '#' );
509 if ( $hashPos !== false ) {
510 $fragment = substr( $url, $hashPos );
511 $url = substr( $url, 0, $hashPos );
515 if ( false === strpos( $url, '?' ) ) {
522 // Put the fragment back
523 if ( $fragment !== false ) {
531 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
534 * The meaning of the PROTO_* constants is as follows:
535 * PROTO_HTTP: Output a URL starting with http://
536 * PROTO_HTTPS: Output a URL starting with https://
537 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
538 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
539 * on which protocol was used for the current incoming request
540 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
541 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
542 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
544 * @todo this won't work with current-path-relative URLs
545 * like "subdir/foo.html", etc.
547 * @param string $url Either fully-qualified or a local path + query
548 * @param string $defaultProto One of the PROTO_* constants. Determines the
549 * protocol to use if $url or $wgServer is protocol-relative
550 * @return string|false Fully-qualified URL, current-path-relative URL or false if
551 * no valid URL can be constructed
553 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
554 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
556 if ( $defaultProto === PROTO_CANONICAL
) {
557 $serverUrl = $wgCanonicalServer;
558 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
559 // Make $wgInternalServer fall back to $wgServer if not set
560 $serverUrl = $wgInternalServer;
562 $serverUrl = $wgServer;
563 if ( $defaultProto === PROTO_CURRENT
) {
564 $defaultProto = $wgRequest->getProtocol() . '://';
568 // Analyze $serverUrl to obtain its protocol
569 $bits = wfParseUrl( $serverUrl );
570 $serverHasProto = $bits && $bits['scheme'] != '';
572 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
573 if ( $serverHasProto ) {
574 $defaultProto = $bits['scheme'] . '://';
576 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
577 // This really isn't supposed to happen. Fall back to HTTP in this
579 $defaultProto = PROTO_HTTP
;
583 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
585 if ( substr( $url, 0, 2 ) == '//' ) {
586 $url = $defaultProtoWithoutSlashes . $url;
587 } elseif ( substr( $url, 0, 1 ) == '/' ) {
588 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
589 // otherwise leave it alone.
590 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
593 $bits = wfParseUrl( $url );
595 // ensure proper port for HTTPS arrives in URL
596 // https://phabricator.wikimedia.org/T67184
597 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
598 $bits['port'] = $wgHttpsPort;
601 if ( $bits && isset( $bits['path'] ) ) {
602 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
603 return wfAssembleUrl( $bits );
607 } elseif ( substr( $url, 0, 1 ) != '/' ) {
608 # URL is a relative path
609 return wfRemoveDotSegments( $url );
612 # Expanded URL is not valid.
617 * This function will reassemble a URL parsed with wfParseURL. This is useful
618 * if you need to edit part of a URL and put it back together.
620 * This is the basic structure used (brackets contain keys for $urlParts):
621 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
623 * @todo Need to integrate this into wfExpandUrl (see T34168)
626 * @param array $urlParts URL parts, as output from wfParseUrl
627 * @return string URL assembled from its component parts
629 function wfAssembleUrl( $urlParts ) {
632 if ( isset( $urlParts['delimiter'] ) ) {
633 if ( isset( $urlParts['scheme'] ) ) {
634 $result .= $urlParts['scheme'];
637 $result .= $urlParts['delimiter'];
640 if ( isset( $urlParts['host'] ) ) {
641 if ( isset( $urlParts['user'] ) ) {
642 $result .= $urlParts['user'];
643 if ( isset( $urlParts['pass'] ) ) {
644 $result .= ':' . $urlParts['pass'];
649 $result .= $urlParts['host'];
651 if ( isset( $urlParts['port'] ) ) {
652 $result .= ':' . $urlParts['port'];
656 if ( isset( $urlParts['path'] ) ) {
657 $result .= $urlParts['path'];
660 if ( isset( $urlParts['query'] ) ) {
661 $result .= '?' . $urlParts['query'];
664 if ( isset( $urlParts['fragment'] ) ) {
665 $result .= '#' . $urlParts['fragment'];
672 * Remove all dot-segments in the provided URL path. For example,
673 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
674 * RFC3986 section 5.2.4.
676 * @todo Need to integrate this into wfExpandUrl (see T34168)
678 * @param string $urlPath URL path, potentially containing dot-segments
679 * @return string URL path with all dot-segments removed
681 function wfRemoveDotSegments( $urlPath ) {
684 $inputLength = strlen( $urlPath );
686 while ( $inputOffset < $inputLength ) {
687 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
688 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
689 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
690 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
693 if ( $prefixLengthTwo == './' ) {
694 # Step A, remove leading "./"
696 } elseif ( $prefixLengthThree == '../' ) {
697 # Step A, remove leading "../"
699 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
700 # Step B, replace leading "/.$" with "/"
702 $urlPath[$inputOffset] = '/';
703 } elseif ( $prefixLengthThree == '/./' ) {
704 # Step B, replace leading "/./" with "/"
706 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
707 # Step C, replace leading "/..$" with "/" and
708 # remove last path component in output
710 $urlPath[$inputOffset] = '/';
712 } elseif ( $prefixLengthFour == '/../' ) {
713 # Step C, replace leading "/../" with "/" and
714 # remove last path component in output
717 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
718 # Step D, remove "^.$"
720 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
721 # Step D, remove "^..$"
724 # Step E, move leading path segment to output
725 if ( $prefixLengthOne == '/' ) {
726 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
728 $slashPos = strpos( $urlPath, '/', $inputOffset );
730 if ( $slashPos === false ) {
731 $output .= substr( $urlPath, $inputOffset );
732 $inputOffset = $inputLength;
734 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
735 $inputOffset +
= $slashPos - $inputOffset;
740 $slashPos = strrpos( $output, '/' );
741 if ( $slashPos === false ) {
744 $output = substr( $output, 0, $slashPos );
753 * Returns a regular expression of url protocols
755 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
756 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
759 function wfUrlProtocols( $includeProtocolRelative = true ) {
760 global $wgUrlProtocols;
762 // Cache return values separately based on $includeProtocolRelative
763 static $withProtRel = null, $withoutProtRel = null;
764 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
765 if ( !is_null( $cachedValue ) ) {
769 // Support old-style $wgUrlProtocols strings, for backwards compatibility
770 // with LocalSettings files from 1.5
771 if ( is_array( $wgUrlProtocols ) ) {
773 foreach ( $wgUrlProtocols as $protocol ) {
774 // Filter out '//' if !$includeProtocolRelative
775 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
776 $protocols[] = preg_quote( $protocol, '/' );
780 $retval = implode( '|', $protocols );
782 // Ignore $includeProtocolRelative in this case
783 // This case exists for pre-1.6 compatibility, and we can safely assume
784 // that '//' won't appear in a pre-1.6 config because protocol-relative
785 // URLs weren't supported until 1.18
786 $retval = $wgUrlProtocols;
789 // Cache return value
790 if ( $includeProtocolRelative ) {
791 $withProtRel = $retval;
793 $withoutProtRel = $retval;
799 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
800 * you need a regex that matches all URL protocols but does not match protocol-
804 function wfUrlProtocolsWithoutProtRel() {
805 return wfUrlProtocols( false );
809 * parse_url() work-alike, but non-broken. Differences:
811 * 1) Does not raise warnings on bad URLs (just returns false).
812 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
813 * protocol-relative URLs) correctly.
814 * 3) Adds a "delimiter" element to the array (see (2)).
815 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
816 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
817 * a line feed character.
819 * @param string $url A URL to parse
820 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
822 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
823 * be an empty string for protocol-relative URLs.
824 * - delimiter: either '://', ':' or '//'. Always present.
825 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
826 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
827 * Missing when there is no username.
828 * - pass: password, same as above.
829 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
830 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
831 * - fragment: the part after #, can be missing.
833 function wfParseUrl( $url ) {
834 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
836 // Protocol-relative URLs are handled really badly by parse_url(). It's so
837 // bad that the easiest way to handle them is to just prepend 'http:' and
838 // strip the protocol out later.
839 $wasRelative = substr( $url, 0, 2 ) == '//';
840 if ( $wasRelative ) {
843 MediaWiki\
suppressWarnings();
844 $bits = parse_url( $url );
845 MediaWiki\restoreWarnings
();
846 // parse_url() returns an array without scheme for some invalid URLs, e.g.
847 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
848 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
852 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
853 $bits['scheme'] = strtolower( $bits['scheme'] );
855 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
856 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
857 $bits['delimiter'] = '://';
858 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
859 $bits['delimiter'] = ':';
860 // parse_url detects for news: and mailto: the host part of an url as path
861 // We have to correct this wrong detection
862 if ( isset( $bits['path'] ) ) {
863 $bits['host'] = $bits['path'];
870 /* Provide an empty host for eg. file:/// urls (see T30627) */
871 if ( !isset( $bits['host'] ) ) {
875 if ( isset( $bits['path'] ) ) {
876 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
877 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
878 $bits['path'] = '/' . $bits['path'];
885 // If the URL was protocol-relative, fix scheme and delimiter
886 if ( $wasRelative ) {
887 $bits['scheme'] = '';
888 $bits['delimiter'] = '//';
894 * Take a URL, make sure it's expanded to fully qualified, and replace any
895 * encoded non-ASCII Unicode characters with their UTF-8 original forms
896 * for more compact display and legibility for local audiences.
898 * @todo handle punycode domains too
903 function wfExpandIRI( $url ) {
904 return preg_replace_callback(
905 '/((?:%[89A-F][0-9A-F])+)/i',
906 'wfExpandIRI_callback',
912 * Private callback for wfExpandIRI
913 * @param array $matches
916 function wfExpandIRI_callback( $matches ) {
917 return urldecode( $matches[1] );
921 * Make URL indexes, appropriate for the el_index field of externallinks.
926 function wfMakeUrlIndexes( $url ) {
927 $bits = wfParseUrl( $url );
929 // Reverse the labels in the hostname, convert to lower case
930 // For emails reverse domainpart only
931 if ( $bits['scheme'] == 'mailto' ) {
932 $mailparts = explode( '@', $bits['host'], 2 );
933 if ( count( $mailparts ) === 2 ) {
934 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
936 // No domain specified, don't mangle it
939 $reversedHost = $domainpart . '@' . $mailparts[0];
941 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
943 // Add an extra dot to the end
944 // Why? Is it in wrong place in mailto links?
945 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
946 $reversedHost .= '.';
948 // Reconstruct the pseudo-URL
949 $prot = $bits['scheme'];
950 $index = $prot . $bits['delimiter'] . $reversedHost;
951 // Leave out user and password. Add the port, path, query and fragment
952 if ( isset( $bits['port'] ) ) {
953 $index .= ':' . $bits['port'];
955 if ( isset( $bits['path'] ) ) {
956 $index .= $bits['path'];
960 if ( isset( $bits['query'] ) ) {
961 $index .= '?' . $bits['query'];
963 if ( isset( $bits['fragment'] ) ) {
964 $index .= '#' . $bits['fragment'];
968 return [ "http:$index", "https:$index" ];
975 * Check whether a given URL has a domain that occurs in a given set of domains
976 * @param string $url URL
977 * @param array $domains Array of domains (strings)
978 * @return bool True if the host part of $url ends in one of the strings in $domains
980 function wfMatchesDomainList( $url, $domains ) {
981 $bits = wfParseUrl( $url );
982 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
983 $host = '.' . $bits['host'];
984 foreach ( (array)$domains as $domain ) {
985 $domain = '.' . $domain;
986 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
995 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
996 * In normal operation this is a NOP.
998 * Controlling globals:
999 * $wgDebugLogFile - points to the log file
1000 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1001 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1003 * @since 1.25 support for additional context data
1005 * @param string $text
1006 * @param string|bool $dest Destination of the message:
1007 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1008 * - 'private': excluded from HTML output
1009 * For backward compatibility, it can also take a boolean:
1010 * - true: same as 'all'
1011 * - false: same as 'private'
1012 * @param array $context Additional logging context data
1014 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1015 global $wgDebugRawPage, $wgDebugLogPrefix;
1016 global $wgDebugTimestamps, $wgRequestTime;
1018 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1022 $text = trim( $text );
1024 if ( $wgDebugTimestamps ) {
1025 $context['seconds_elapsed'] = sprintf(
1027 microtime( true ) - $wgRequestTime
1029 $context['memory_used'] = sprintf(
1031 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1035 if ( $wgDebugLogPrefix !== '' ) {
1036 $context['prefix'] = $wgDebugLogPrefix;
1038 $context['private'] = ( $dest === false ||
$dest === 'private' );
1040 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1041 $logger->debug( $text, $context );
1045 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1048 function wfIsDebugRawPage() {
1050 if ( $cache !== null ) {
1053 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1054 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1056 isset( $_SERVER['SCRIPT_NAME'] )
1057 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1068 * Send a line giving PHP memory usage.
1070 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1072 function wfDebugMem( $exact = false ) {
1073 $mem = memory_get_usage();
1075 $mem = floor( $mem / 1024 ) . ' KiB';
1079 wfDebug( "Memory usage: $mem\n" );
1083 * Send a line to a supplementary debug log file, if configured, or main debug
1086 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1087 * a string filename or an associative array mapping 'destination' to the
1088 * desired filename. The associative array may also contain a 'sample' key
1089 * with an integer value, specifying a sampling factor. Sampled log events
1090 * will be emitted with a 1 in N random chance.
1092 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1093 * @since 1.25 support for additional context data
1094 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1096 * @param string $logGroup
1097 * @param string $text
1098 * @param string|bool $dest Destination of the message:
1099 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1100 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1101 * discarded otherwise
1102 * For backward compatibility, it can also take a boolean:
1103 * - true: same as 'all'
1104 * - false: same as 'private'
1105 * @param array $context Additional logging context data
1107 function wfDebugLog(
1108 $logGroup, $text, $dest = 'all', array $context = []
1110 $text = trim( $text );
1112 $logger = LoggerFactory
::getInstance( $logGroup );
1113 $context['private'] = ( $dest === false ||
$dest === 'private' );
1114 $logger->info( $text, $context );
1118 * Log for database errors
1120 * @since 1.25 support for additional context data
1122 * @param string $text Database error message.
1123 * @param array $context Additional logging context data
1125 function wfLogDBError( $text, array $context = [] ) {
1126 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1127 $logger->error( trim( $text ), $context );
1131 * Throws a warning that $function is deprecated
1133 * @param string $function
1134 * @param string|bool $version Version of MediaWiki that the function
1135 * was deprecated in (Added in 1.19).
1136 * @param string|bool $component Added in 1.19.
1137 * @param int $callerOffset How far up the call stack is the original
1138 * caller. 2 = function that called the function that called
1139 * wfDeprecated (Added in 1.20)
1143 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1144 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1148 * Send a warning either to the debug log or in a PHP error depending on
1149 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1151 * @param string $msg Message to send
1152 * @param int $callerOffset Number of items to go back in the backtrace to
1153 * find the correct caller (1 = function calling wfWarn, ...)
1154 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1155 * only used when $wgDevelopmentWarnings is true
1157 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1158 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1162 * Send a warning as a PHP error and the debug log. This is intended for logging
1163 * warnings in production. For logging development warnings, use WfWarn instead.
1165 * @param string $msg Message to send
1166 * @param int $callerOffset Number of items to go back in the backtrace to
1167 * find the correct caller (1 = function calling wfLogWarning, ...)
1168 * @param int $level PHP error level; defaults to E_USER_WARNING
1170 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1171 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1175 * Log to a file without getting "file size exceeded" signals.
1177 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1178 * send lines to the specified port, prefixed by the specified prefix and a space.
1179 * @since 1.25 support for additional context data
1181 * @param string $text
1182 * @param string $file Filename
1183 * @param array $context Additional logging context data
1184 * @throws MWException
1185 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1187 function wfErrorLog( $text, $file, array $context = [] ) {
1188 wfDeprecated( __METHOD__
, '1.25' );
1189 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1190 $context['destination'] = $file;
1191 $logger->info( trim( $text ), $context );
1197 function wfLogProfilingData() {
1198 global $wgDebugLogGroups, $wgDebugRawPage;
1200 $context = RequestContext
::getMain();
1201 $request = $context->getRequest();
1203 $profiler = Profiler
::instance();
1204 $profiler->setContext( $context );
1205 $profiler->logData();
1207 $config = $context->getConfig();
1208 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1209 if ( $config->get( 'StatsdServer' ) && $stats->hasData() ) {
1211 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1212 $statsdHost = $statsdServer[0];
1213 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1214 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1215 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1216 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
1217 $statsdClient->send( $stats->getData() );
1218 } catch ( Exception
$ex ) {
1219 MWExceptionHandler
::logException( $ex );
1223 # Profiling must actually be enabled...
1224 if ( $profiler instanceof ProfilerStub
) {
1228 if ( isset( $wgDebugLogGroups['profileoutput'] )
1229 && $wgDebugLogGroups['profileoutput'] === false
1231 // Explicitly disabled
1234 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1238 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1239 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1240 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1242 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1243 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1245 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1246 $ctx['from'] = $_SERVER['HTTP_FROM'];
1248 if ( isset( $ctx['forwarded_for'] ) ||
1249 isset( $ctx['client_ip'] ) ||
1250 isset( $ctx['from'] ) ) {
1251 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1254 // Don't load $wgUser at this late stage just for statistics purposes
1255 // @todo FIXME: We can detect some anons even if it is not loaded.
1256 // See User::getId()
1257 $user = $context->getUser();
1258 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1260 // Command line script uses a FauxRequest object which does not have
1261 // any knowledge about an URL and throw an exception instead.
1263 $ctx['url'] = urldecode( $request->getRequestURL() );
1264 } catch ( Exception
$ignored ) {
1268 $ctx['output'] = $profiler->getOutput();
1270 $log = LoggerFactory
::getInstance( 'profileoutput' );
1271 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1275 * Increment a statistics counter
1277 * @param string $key
1281 function wfIncrStats( $key, $count = 1 ) {
1282 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1283 $stats->updateCount( $key, $count );
1287 * Check whether the wiki is in read-only mode.
1291 function wfReadOnly() {
1292 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1297 * Check if the site is in read-only mode and return the message if so
1299 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1300 * for replica DB lag. This may result in DB connection being made.
1302 * @return string|bool String when in read-only mode; false otherwise
1304 function wfReadOnlyReason() {
1305 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1310 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1312 * @return string|bool String when in read-only mode; false otherwise
1315 function wfConfiguredReadOnlyReason() {
1316 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1321 * Return a Language object from $langcode
1323 * @param Language|string|bool $langcode Either:
1324 * - a Language object
1325 * - code of the language to get the message for, if it is
1326 * a valid code create a language for that language, if
1327 * it is a string but not a valid code then make a basic
1329 * - a boolean: if it's false then use the global object for
1330 * the current user's language (as a fallback for the old parameter
1331 * functionality), or if it is true then use global object
1332 * for the wiki's content language.
1335 function wfGetLangObj( $langcode = false ) {
1336 # Identify which language to get or create a language object for.
1337 # Using is_object here due to Stub objects.
1338 if ( is_object( $langcode ) ) {
1339 # Great, we already have the object (hopefully)!
1343 global $wgContLang, $wgLanguageCode;
1344 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1345 # $langcode is the language code of the wikis content language object.
1346 # or it is a boolean and value is true
1351 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1352 # $langcode is the language code of user language object.
1353 # or it was a boolean and value is false
1357 $validCodes = array_keys( Language
::fetchLanguageNames() );
1358 if ( in_array( $langcode, $validCodes ) ) {
1359 # $langcode corresponds to a valid language.
1360 return Language
::factory( $langcode );
1363 # $langcode is a string, but not a valid language code; use content language.
1364 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1369 * This is the function for getting translated interface messages.
1371 * @see Message class for documentation how to use them.
1372 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1374 * This function replaces all old wfMsg* functions.
1376 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1377 * @param mixed $params,... Normal message parameters
1382 * @see Message::__construct
1384 function wfMessage( $key /*...*/ ) {
1385 $message = new Message( $key );
1387 // We call Message::params() to reduce code duplication
1388 $params = func_get_args();
1389 array_shift( $params );
1391 call_user_func_array( [ $message, 'params' ], $params );
1398 * This function accepts multiple message keys and returns a message instance
1399 * for the first message which is non-empty. If all messages are empty then an
1400 * instance of the first message key is returned.
1402 * @param string|string[] $keys,... Message keys
1407 * @see Message::newFallbackSequence
1409 function wfMessageFallback( /*...*/ ) {
1410 $args = func_get_args();
1411 return call_user_func_array( 'Message::newFallbackSequence', $args );
1415 * Replace message parameter keys on the given formatted output.
1417 * @param string $message
1418 * @param array $args
1422 function wfMsgReplaceArgs( $message, $args ) {
1423 # Fix windows line-endings
1424 # Some messages are split with explode("\n", $msg)
1425 $message = str_replace( "\r", '', $message );
1427 // Replace arguments
1428 if ( is_array( $args ) && $args ) {
1429 if ( is_array( $args[0] ) ) {
1430 $args = array_values( $args[0] );
1432 $replacementKeys = [];
1433 foreach ( $args as $n => $param ) {
1434 $replacementKeys['$' . ( $n +
1 )] = $param;
1436 $message = strtr( $message, $replacementKeys );
1443 * Fetch server name for use in error reporting etc.
1444 * Use real server name if available, so we know which machine
1445 * in a server farm generated the current page.
1449 function wfHostname() {
1451 if ( is_null( $host ) ) {
1452 # Hostname overriding
1453 global $wgOverrideHostname;
1454 if ( $wgOverrideHostname !== false ) {
1455 # Set static and skip any detection
1456 $host = $wgOverrideHostname;
1460 if ( function_exists( 'posix_uname' ) ) {
1461 // This function not present on Windows
1462 $uname = posix_uname();
1466 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1467 $host = $uname['nodename'];
1468 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1469 # Windows computer name
1470 $host = getenv( 'COMPUTERNAME' );
1472 # This may be a virtual server.
1473 $host = $_SERVER['SERVER_NAME'];
1480 * Returns a script tag that stores the amount of time it took MediaWiki to
1481 * handle the request in milliseconds as 'wgBackendResponseTime'.
1483 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1484 * hostname of the server handling the request.
1488 function wfReportTime() {
1489 global $wgRequestTime, $wgShowHostnames;
1491 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1492 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1493 if ( $wgShowHostnames ) {
1494 $reportVars['wgHostname'] = wfHostname();
1496 return Skin
::makeVariablesScript( $reportVars );
1500 * Safety wrapper for debug_backtrace().
1502 * Will return an empty array if debug_backtrace is disabled, otherwise
1503 * the output from debug_backtrace() (trimmed).
1505 * @param int $limit This parameter can be used to limit the number of stack frames returned
1507 * @return array Array of backtrace information
1509 function wfDebugBacktrace( $limit = 0 ) {
1510 static $disabled = null;
1512 if ( is_null( $disabled ) ) {
1513 $disabled = !function_exists( 'debug_backtrace' );
1515 wfDebug( "debug_backtrace() is disabled\n" );
1523 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1525 return array_slice( debug_backtrace(), 1 );
1530 * Get a debug backtrace as a string
1532 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1533 * Defaults to $wgCommandLineMode if unset.
1535 * @since 1.25 Supports $raw parameter.
1537 function wfBacktrace( $raw = null ) {
1538 global $wgCommandLineMode;
1540 if ( $raw === null ) {
1541 $raw = $wgCommandLineMode;
1545 $frameFormat = "%s line %s calls %s()\n";
1546 $traceFormat = "%s";
1548 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1549 $traceFormat = "<ul>\n%s</ul>\n";
1552 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1553 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1554 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1555 $call = $frame['function'];
1556 if ( !empty( $frame['class'] ) ) {
1557 $call = $frame['class'] . $frame['type'] . $call;
1559 return sprintf( $frameFormat, $file, $line, $call );
1560 }, wfDebugBacktrace() );
1562 return sprintf( $traceFormat, implode( '', $frames ) );
1566 * Get the name of the function which called this function
1567 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1568 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1569 * wfGetCaller( 3 ) is the parent of that.
1574 function wfGetCaller( $level = 2 ) {
1575 $backtrace = wfDebugBacktrace( $level +
1 );
1576 if ( isset( $backtrace[$level] ) ) {
1577 return wfFormatStackFrame( $backtrace[$level] );
1584 * Return a string consisting of callers in the stack. Useful sometimes
1585 * for profiling specific points.
1587 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1590 function wfGetAllCallers( $limit = 3 ) {
1591 $trace = array_reverse( wfDebugBacktrace() );
1592 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1593 $limit = count( $trace ) - 1;
1595 $trace = array_slice( $trace, -$limit - 1, $limit );
1596 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1600 * Return a string representation of frame
1602 * @param array $frame
1605 function wfFormatStackFrame( $frame ) {
1606 if ( !isset( $frame['function'] ) ) {
1607 return 'NO_FUNCTION_GIVEN';
1609 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1610 $frame['class'] . $frame['type'] . $frame['function'] :
1614 /* Some generic result counters, pulled out of SearchEngine */
1619 * @param int $offset
1623 function wfShowingResults( $offset, $limit ) {
1624 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1628 * Whether the client accept gzip encoding
1630 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1631 * Use this when considering to send a gzip-encoded response to the client.
1633 * @param bool $force Forces another check even if we already have a cached result.
1636 function wfClientAcceptsGzip( $force = false ) {
1637 static $result = null;
1638 if ( $result === null ||
$force ) {
1640 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1641 # @todo FIXME: We may want to blacklist some broken browsers
1644 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1645 $_SERVER['HTTP_ACCEPT_ENCODING'],
1649 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1653 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1662 * Escapes the given text so that it may be output using addWikiText()
1663 * without any linking, formatting, etc. making its way through. This
1664 * is achieved by substituting certain characters with HTML entities.
1665 * As required by the callers, "<nowiki>" is not used.
1667 * @param string $text Text to be escaped
1670 function wfEscapeWikiText( $text ) {
1671 global $wgEnableMagicLinks;
1672 static $repl = null, $repl2 = null;
1673 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1674 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1675 // in those situations
1677 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1678 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1679 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1680 "\n#" => "\n#", "\r#" => "\r#",
1681 "\n*" => "\n*", "\r*" => "\r*",
1682 "\n:" => "\n:", "\r:" => "\r:",
1683 "\n " => "\n ", "\r " => "\r ",
1684 "\n\n" => "\n ", "\r\n" => " \n",
1685 "\n\r" => "\n ", "\r\r" => "\r ",
1686 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1687 "\n----" => "\n----", "\r----" => "\r----",
1688 '__' => '__', '://' => '://',
1691 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1692 // We have to catch everything "\s" matches in PCRE
1693 foreach ( $magicLinks as $magic ) {
1694 $repl["$magic "] = "$magic ";
1695 $repl["$magic\t"] = "$magic	";
1696 $repl["$magic\r"] = "$magic ";
1697 $repl["$magic\n"] = "$magic ";
1698 $repl["$magic\f"] = "$magic";
1701 // And handle protocols that don't use "://"
1702 global $wgUrlProtocols;
1704 foreach ( $wgUrlProtocols as $prot ) {
1705 if ( substr( $prot, -1 ) === ':' ) {
1706 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1709 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1711 $text = substr( strtr( "\n$text", $repl ), 1 );
1712 $text = preg_replace( $repl2, '$1:', $text );
1717 * Sets dest to source and returns the original value of dest
1718 * If source is NULL, it just returns the value, it doesn't set the variable
1719 * If force is true, it will set the value even if source is NULL
1721 * @param mixed $dest
1722 * @param mixed $source
1723 * @param bool $force
1726 function wfSetVar( &$dest, $source, $force = false ) {
1728 if ( !is_null( $source ) ||
$force ) {
1735 * As for wfSetVar except setting a bit
1739 * @param bool $state
1743 function wfSetBit( &$dest, $bit, $state = true ) {
1744 $temp = (bool)( $dest & $bit );
1745 if ( !is_null( $state ) ) {
1756 * A wrapper around the PHP function var_export().
1757 * Either print it or add it to the regular output ($wgOut).
1759 * @param mixed $var A PHP variable to dump.
1761 function wfVarDump( $var ) {
1763 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1764 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1767 $wgOut->addHTML( $s );
1772 * Provide a simple HTTP error.
1774 * @param int|string $code
1775 * @param string $label
1776 * @param string $desc
1778 function wfHttpError( $code, $label, $desc ) {
1780 HttpStatus
::header( $code );
1783 $wgOut->sendCacheControl();
1786 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1787 header( 'Content-type: text/html; charset=utf-8' );
1788 print '<!DOCTYPE html>' .
1789 '<html><head><title>' .
1790 htmlspecialchars( $label ) .
1791 '</title></head><body><h1>' .
1792 htmlspecialchars( $label ) .
1794 nl2br( htmlspecialchars( $desc ) ) .
1795 "</p></body></html>\n";
1799 * Clear away any user-level output buffers, discarding contents.
1801 * Suitable for 'starting afresh', for instance when streaming
1802 * relatively large amounts of data without buffering, or wanting to
1803 * output image files without ob_gzhandler's compression.
1805 * The optional $resetGzipEncoding parameter controls suppression of
1806 * the Content-Encoding header sent by ob_gzhandler; by default it
1807 * is left. See comments for wfClearOutputBuffers() for why it would
1810 * Note that some PHP configuration options may add output buffer
1811 * layers which cannot be removed; these are left in place.
1813 * @param bool $resetGzipEncoding
1815 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1816 if ( $resetGzipEncoding ) {
1817 // Suppress Content-Encoding and Content-Length
1818 // headers from 1.10+s wfOutputHandler
1819 global $wgDisableOutputCompression;
1820 $wgDisableOutputCompression = true;
1822 while ( $status = ob_get_status() ) {
1823 if ( isset( $status['flags'] ) ) {
1824 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1825 $deleteable = ( $status['flags'] & $flags ) === $flags;
1826 } elseif ( isset( $status['del'] ) ) {
1827 $deleteable = $status['del'];
1829 // Guess that any PHP-internal setting can't be removed.
1830 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1832 if ( !$deleteable ) {
1833 // Give up, and hope the result doesn't break
1837 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1838 // Unit testing barrier to prevent this function from breaking PHPUnit.
1841 if ( !ob_end_clean() ) {
1842 // Could not remove output buffer handler; abort now
1843 // to avoid getting in some kind of infinite loop.
1846 if ( $resetGzipEncoding ) {
1847 if ( $status['name'] == 'ob_gzhandler' ) {
1848 // Reset the 'Content-Encoding' field set by this handler
1849 // so we can start fresh.
1850 header_remove( 'Content-Encoding' );
1858 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1860 * Clear away output buffers, but keep the Content-Encoding header
1861 * produced by ob_gzhandler, if any.
1863 * This should be used for HTTP 304 responses, where you need to
1864 * preserve the Content-Encoding header of the real result, but
1865 * also need to suppress the output of ob_gzhandler to keep to spec
1866 * and avoid breaking Firefox in rare cases where the headers and
1867 * body are broken over two packets.
1869 function wfClearOutputBuffers() {
1870 wfResetOutputBuffers( false );
1874 * Converts an Accept-* header into an array mapping string values to quality
1877 * @param string $accept
1878 * @param string $def Default
1879 * @return float[] Associative array of string => float pairs
1881 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1882 # No arg means accept anything (per HTTP spec)
1884 return [ $def => 1.0 ];
1889 $parts = explode( ',', $accept );
1891 foreach ( $parts as $part ) {
1892 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1893 $values = explode( ';', trim( $part ) );
1895 if ( count( $values ) == 1 ) {
1896 $prefs[$values[0]] = 1.0;
1897 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1898 $prefs[$values[0]] = floatval( $match[1] );
1906 * Checks if a given MIME type matches any of the keys in the given
1907 * array. Basic wildcards are accepted in the array keys.
1909 * Returns the matching MIME type (or wildcard) if a match, otherwise
1912 * @param string $type
1913 * @param array $avail
1917 function mimeTypeMatch( $type, $avail ) {
1918 if ( array_key_exists( $type, $avail ) ) {
1921 $mainType = explode( '/', $type )[0];
1922 if ( array_key_exists( "$mainType/*", $avail ) ) {
1923 return "$mainType/*";
1924 } elseif ( array_key_exists( '*/*', $avail ) ) {
1933 * Returns the 'best' match between a client's requested internet media types
1934 * and the server's list of available types. Each list should be an associative
1935 * array of type to preference (preference is a float between 0.0 and 1.0).
1936 * Wildcards in the types are acceptable.
1938 * @param array $cprefs Client's acceptable type list
1939 * @param array $sprefs Server's offered types
1942 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1943 * XXX: generalize to negotiate other stuff
1945 function wfNegotiateType( $cprefs, $sprefs ) {
1948 foreach ( array_keys( $sprefs ) as $type ) {
1949 $subType = explode( '/', $type )[1];
1950 if ( $subType != '*' ) {
1951 $ckey = mimeTypeMatch( $type, $cprefs );
1953 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1958 foreach ( array_keys( $cprefs ) as $type ) {
1959 $subType = explode( '/', $type )[1];
1960 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1961 $skey = mimeTypeMatch( $type, $sprefs );
1963 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1971 foreach ( array_keys( $combine ) as $type ) {
1972 if ( $combine[$type] > $bestq ) {
1974 $bestq = $combine[$type];
1982 * Reference-counted warning suppression
1984 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
1987 function wfSuppressWarnings( $end = false ) {
1988 MediaWiki\
suppressWarnings( $end );
1992 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
1993 * Restore error level to previous value
1995 function wfRestoreWarnings() {
1996 MediaWiki\
suppressWarnings( true );
2000 * Get a timestamp string in one of various formats
2002 * @param mixed $outputtype A timestamp in one of the supported formats, the
2003 * function will autodetect which format is supplied and act accordingly.
2004 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2005 * @return string|bool String / false The same date in the format specified in $outputtype or false
2007 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2008 $ret = MWTimestamp
::convert( $outputtype, $ts );
2009 if ( $ret === false ) {
2010 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2016 * Return a formatted timestamp, or null if input is null.
2017 * For dealing with nullable timestamp columns in the database.
2019 * @param int $outputtype
2023 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2024 if ( is_null( $ts ) ) {
2027 return wfTimestamp( $outputtype, $ts );
2032 * Convenience function; returns MediaWiki timestamp for the present time.
2036 function wfTimestampNow() {
2038 return MWTimestamp
::now( TS_MW
);
2042 * Check if the operating system is Windows
2044 * @return bool True if it's Windows, false otherwise.
2046 function wfIsWindows() {
2047 static $isWindows = null;
2048 if ( $isWindows === null ) {
2049 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2055 * Check if we are running under HHVM
2059 function wfIsHHVM() {
2060 return defined( 'HHVM_VERSION' );
2064 * Tries to get the system directory for temporary files. First
2065 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2066 * environment variables are then checked in sequence, then
2067 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2069 * NOTE: When possible, use instead the tmpfile() function to create
2070 * temporary files to avoid race conditions on file creation, etc.
2074 function wfTempDir() {
2075 global $wgTmpDirectory;
2077 if ( $wgTmpDirectory !== false ) {
2078 return $wgTmpDirectory;
2081 return TempFSFile
::getUsableTempDirectory();
2085 * Make directory, and make all parent directories if they don't exist
2087 * @param string $dir Full path to directory to create
2088 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2089 * @param string $caller Optional caller param for debugging.
2090 * @throws MWException
2093 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2094 global $wgDirectoryMode;
2096 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2097 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2100 if ( !is_null( $caller ) ) {
2101 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2104 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2108 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2110 if ( is_null( $mode ) ) {
2111 $mode = $wgDirectoryMode;
2114 // Turn off the normal warning, we're doing our own below
2115 MediaWiki\
suppressWarnings();
2116 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2117 MediaWiki\restoreWarnings
();
2120 // directory may have been created on another request since we last checked
2121 if ( is_dir( $dir ) ) {
2125 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2126 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2132 * Remove a directory and all its content.
2133 * Does not hide error.
2134 * @param string $dir
2136 function wfRecursiveRemoveDir( $dir ) {
2137 wfDebug( __FUNCTION__
. "( $dir )\n" );
2138 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2139 if ( is_dir( $dir ) ) {
2140 $objects = scandir( $dir );
2141 foreach ( $objects as $object ) {
2142 if ( $object != "." && $object != ".." ) {
2143 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2144 wfRecursiveRemoveDir( $dir . '/' . $object );
2146 unlink( $dir . '/' . $object );
2156 * @param int $nr The number to format
2157 * @param int $acc The number of digits after the decimal point, default 2
2158 * @param bool $round Whether or not to round the value, default true
2161 function wfPercent( $nr, $acc = 2, $round = true ) {
2162 $ret = sprintf( "%.${acc}f", $nr );
2163 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2167 * Safety wrapper around ini_get() for boolean settings.
2168 * The values returned from ini_get() are pre-normalized for settings
2169 * set via php.ini or php_flag/php_admin_flag... but *not*
2170 * for those set via php_value/php_admin_value.
2172 * It's fairly common for people to use php_value instead of php_flag,
2173 * which can leave you with an 'off' setting giving a false positive
2174 * for code that just takes the ini_get() return value as a boolean.
2176 * To make things extra interesting, setting via php_value accepts
2177 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2178 * Unrecognized values go false... again opposite PHP's own coercion
2179 * from string to bool.
2181 * Luckily, 'properly' set settings will always come back as '0' or '1',
2182 * so we only have to worry about them and the 'improper' settings.
2184 * I frickin' hate PHP... :P
2186 * @param string $setting
2189 function wfIniGetBool( $setting ) {
2190 $val = strtolower( ini_get( $setting ) );
2191 // 'on' and 'true' can't have whitespace around them, but '1' can.
2195 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2199 * Version of escapeshellarg() that works better on Windows.
2201 * Originally, this fixed the incorrect use of single quotes on Windows
2202 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2203 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2205 * @param string ... strings to escape and glue together, or a single array of strings parameter
2208 function wfEscapeShellArg( /*...*/ ) {
2209 $args = func_get_args();
2210 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2211 // If only one argument has been passed, and that argument is an array,
2212 // treat it as a list of arguments
2213 $args = reset( $args );
2218 foreach ( $args as $arg ) {
2225 if ( wfIsWindows() ) {
2226 // Escaping for an MSVC-style command line parser and CMD.EXE
2227 // @codingStandardsIgnoreStart For long URLs
2229 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2230 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
2233 // Double the backslashes before any double quotes. Escape the double quotes.
2234 // @codingStandardsIgnoreEnd
2235 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2238 foreach ( $tokens as $token ) {
2239 if ( $iteration %
2 == 1 ) {
2240 // Delimiter, a double quote preceded by zero or more slashes
2241 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2242 } elseif ( $iteration %
4 == 2 ) {
2243 // ^ in $token will be outside quotes, need to be escaped
2244 $arg .= str_replace( '^', '^^', $token );
2245 } else { // $iteration % 4 == 0
2246 // ^ in $token will appear inside double quotes, so leave as is
2251 // Double the backslashes before the end of the string, because
2252 // we will soon add a quote
2254 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2255 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2258 // Add surrounding quotes
2259 $retVal .= '"' . $arg . '"';
2261 $retVal .= escapeshellarg( $arg );
2268 * Check if wfShellExec() is effectively disabled via php.ini config
2270 * @return bool|string False or 'disabled'
2273 function wfShellExecDisabled() {
2274 static $disabled = null;
2275 if ( is_null( $disabled ) ) {
2276 if ( !function_exists( 'proc_open' ) ) {
2277 wfDebug( "proc_open() is disabled\n" );
2278 $disabled = 'disabled';
2287 * Execute a shell command, with time and memory limits mirrored from the PHP
2288 * configuration if supported.
2290 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2291 * or an array of unescaped arguments, in which case each value will be escaped
2292 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2293 * @param null|mixed &$retval Optional, will receive the program's exit code.
2294 * (non-zero is usually failure). If there is an error from
2295 * read, select, or proc_open(), this will be set to -1.
2296 * @param array $environ Optional environment variables which should be
2297 * added to the executed command environment.
2298 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2299 * this overwrites the global wgMaxShell* limits.
2300 * @param array $options Array of options:
2301 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2302 * including errors from limit.sh
2303 * - profileMethod: By default this function will profile based on the calling
2304 * method. Set this to a string for an alternative method to profile from
2306 * @return string Collected stdout as a string
2308 function wfShellExec( $cmd, &$retval = null, $environ = [],
2309 $limits = [], $options = []
2311 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2312 $wgMaxShellWallClockTime, $wgShellCgroup;
2314 $disabled = wfShellExecDisabled();
2317 return 'Unable to run external programs, proc_open() is disabled.';
2320 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2321 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2324 foreach ( $environ as $k => $v ) {
2325 if ( wfIsWindows() ) {
2326 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2327 * appear in the environment variable, so we must use carat escaping as documented in
2328 * https://technet.microsoft.com/en-us/library/cc723564.aspx
2329 * Note however that the quote isn't listed there, but is needed, and the parentheses
2330 * are listed there but doesn't appear to need it.
2332 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2334 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2335 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2337 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2340 if ( is_array( $cmd ) ) {
2341 $cmd = wfEscapeShellArg( $cmd );
2344 $cmd = $envcmd . $cmd;
2346 $useLogPipe = false;
2347 if ( is_executable( '/bin/bash' ) ) {
2348 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2349 if ( isset( $limits['walltime'] ) ) {
2350 $wallTime = intval( $limits['walltime'] );
2351 } elseif ( isset( $limits['time'] ) ) {
2354 $wallTime = intval( $wgMaxShellWallClockTime );
2356 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2357 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2359 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2360 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2361 escapeshellarg( $cmd ) . ' ' .
2363 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2364 "MW_CPU_LIMIT=$time; " .
2365 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2366 "MW_MEM_LIMIT=$mem; " .
2367 "MW_FILE_SIZE_LIMIT=$filesize; " .
2368 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2369 "MW_USE_LOG_PIPE=yes"
2372 } elseif ( $includeStderr ) {
2375 } elseif ( $includeStderr ) {
2378 wfDebug( "wfShellExec: $cmd\n" );
2380 // Don't try to execute commands that exceed Linux's MAX_ARG_STRLEN.
2381 // Other platforms may be more accomodating, but we don't want to be
2382 // accomodating, because very long commands probably include user
2383 // input. See T129506.
2384 if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN
) {
2385 throw new Exception( __METHOD__
.
2386 '(): total length of $cmd must not exceed SHELL_MAX_ARG_STRLEN' );
2390 0 => [ 'file', 'php://stdin', 'r' ],
2391 1 => [ 'pipe', 'w' ],
2392 2 => [ 'file', 'php://stderr', 'w' ] ];
2393 if ( $useLogPipe ) {
2394 $desc[3] = [ 'pipe', 'w' ];
2397 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2398 $proc = proc_open( $cmd, $desc, $pipes );
2400 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2404 $outBuffer = $logBuffer = '';
2409 /* According to the documentation, it is possible for stream_select()
2410 * to fail due to EINTR. I haven't managed to induce this in testing
2411 * despite sending various signals. If it did happen, the error
2412 * message would take the form:
2414 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2416 * where [4] is the value of the macro EINTR and "Interrupted system
2417 * call" is string which according to the Linux manual is "possibly"
2418 * localised according to LC_MESSAGES.
2420 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2421 $eintrMessage = "stream_select(): unable to select [$eintr]";
2427 while ( $running === true ||
$numReadyPipes !== 0 ) {
2429 $status = proc_get_status( $proc );
2430 // If the process has terminated, switch to nonblocking selects
2431 // for getting any data still waiting to be read.
2432 if ( !$status['running'] ) {
2438 $readyPipes = $pipes;
2441 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2442 @trigger_error
( '' );
2443 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2444 if ( $numReadyPipes === false ) {
2445 // @codingStandardsIgnoreEnd
2446 $error = error_get_last();
2447 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2450 trigger_error( $error['message'], E_USER_WARNING
);
2451 $logMsg = $error['message'];
2455 foreach ( $readyPipes as $fd => $pipe ) {
2456 $block = fread( $pipe, 65536 );
2457 if ( $block === '' ) {
2459 fclose( $pipes[$fd] );
2460 unset( $pipes[$fd] );
2464 } elseif ( $block === false ) {
2466 $logMsg = "Error reading from pipe";
2468 } elseif ( $fd == 1 ) {
2470 $outBuffer .= $block;
2471 } elseif ( $fd == 3 ) {
2473 $logBuffer .= $block;
2474 if ( strpos( $block, "\n" ) !== false ) {
2475 $lines = explode( "\n", $logBuffer );
2476 $logBuffer = array_pop( $lines );
2477 foreach ( $lines as $line ) {
2478 wfDebugLog( 'exec', $line );
2485 foreach ( $pipes as $pipe ) {
2489 // Use the status previously collected if possible, since proc_get_status()
2490 // just calls waitpid() which will not return anything useful the second time.
2492 $status = proc_get_status( $proc );
2495 if ( $logMsg !== false ) {
2496 // Read/select error
2498 proc_close( $proc );
2499 } elseif ( $status['signaled'] ) {
2500 $logMsg = "Exited with signal {$status['termsig']}";
2501 $retval = 128 +
$status['termsig'];
2502 proc_close( $proc );
2504 if ( $status['running'] ) {
2505 $retval = proc_close( $proc );
2507 $retval = $status['exitcode'];
2508 proc_close( $proc );
2510 if ( $retval == 127 ) {
2511 $logMsg = "Possibly missing executable file";
2512 } elseif ( $retval >= 129 && $retval <= 192 ) {
2513 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2517 if ( $logMsg !== false ) {
2518 wfDebugLog( 'exec', "$logMsg: $cmd" );
2525 * Execute a shell command, returning both stdout and stderr. Convenience
2526 * function, as all the arguments to wfShellExec can become unwieldy.
2528 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2529 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2530 * or an array of unescaped arguments, in which case each value will be escaped
2531 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2532 * @param null|mixed &$retval Optional, will receive the program's exit code.
2533 * (non-zero is usually failure)
2534 * @param array $environ Optional environment variables which should be
2535 * added to the executed command environment.
2536 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2537 * this overwrites the global wgMaxShell* limits.
2538 * @return string Collected stdout and stderr as a string
2540 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2541 return wfShellExec( $cmd, $retval, $environ, $limits,
2542 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2546 * Formerly set the locale for locale-sensitive operations
2548 * This is now done in Setup.php.
2550 * @deprecated since 1.30, no longer needed
2551 * @see $wgShellLocale
2553 function wfInitShellLocale() {
2557 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2558 * Note that $parameters should be a flat array and an option with an argument
2559 * should consist of two consecutive items in the array (do not use "--option value").
2561 * @param string $script MediaWiki cli script path
2562 * @param array $parameters Arguments and options to the script
2563 * @param array $options Associative array of options:
2564 * 'php': The path to the php executable
2565 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2568 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2570 // Give site config file a chance to run the script in a wrapper.
2571 // The caller may likely want to call wfBasename() on $script.
2572 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2573 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2574 if ( isset( $options['wrapper'] ) ) {
2575 $cmd[] = $options['wrapper'];
2578 // Escape each parameter for shell
2579 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
2583 * wfMerge attempts to merge differences between three texts.
2584 * Returns true for a clean merge and false for failure or a conflict.
2586 * @param string $old
2587 * @param string $mine
2588 * @param string $yours
2589 * @param string $result
2592 function wfMerge( $old, $mine, $yours, &$result ) {
2595 # This check may also protect against code injection in
2596 # case of broken installations.
2597 MediaWiki\
suppressWarnings();
2598 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2599 MediaWiki\restoreWarnings
();
2601 if ( !$haveDiff3 ) {
2602 wfDebug( "diff3 not found\n" );
2606 # Make temporary files
2608 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2609 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2610 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2612 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2613 # a newline character. To avoid this, we normalize the trailing whitespace before
2614 # creating the diff.
2616 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2617 fclose( $oldtextFile );
2618 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2619 fclose( $mytextFile );
2620 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2621 fclose( $yourtextFile );
2623 # Check for a conflict
2624 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
2625 $oldtextName, $yourtextName );
2626 $handle = popen( $cmd, 'r' );
2628 if ( fgets( $handle, 1024 ) ) {
2636 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2637 $oldtextName, $yourtextName );
2638 $handle = popen( $cmd, 'r' );
2641 $data = fread( $handle, 8192 );
2642 if ( strlen( $data ) == 0 ) {
2648 unlink( $mytextName );
2649 unlink( $oldtextName );
2650 unlink( $yourtextName );
2652 if ( $result === '' && $old !== '' && !$conflict ) {
2653 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2660 * Returns unified plain-text diff of two texts.
2661 * "Useful" for machine processing of diffs.
2663 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2665 * @param string $before The text before the changes.
2666 * @param string $after The text after the changes.
2667 * @param string $params Command-line options for the diff command.
2668 * @return string Unified diff of $before and $after
2670 function wfDiff( $before, $after, $params = '-u' ) {
2671 if ( $before == $after ) {
2676 MediaWiki\
suppressWarnings();
2677 $haveDiff = $wgDiff && file_exists( $wgDiff );
2678 MediaWiki\restoreWarnings
();
2680 # This check may also protect against code injection in
2681 # case of broken installations.
2683 wfDebug( "diff executable not found\n" );
2684 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2685 $format = new UnifiedDiffFormatter();
2686 return $format->format( $diffs );
2689 # Make temporary files
2691 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2692 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2694 fwrite( $oldtextFile, $before );
2695 fclose( $oldtextFile );
2696 fwrite( $newtextFile, $after );
2697 fclose( $newtextFile );
2699 // Get the diff of the two files
2700 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2702 $h = popen( $cmd, 'r' );
2704 unlink( $oldtextName );
2705 unlink( $newtextName );
2706 throw new Exception( __METHOD__
. '(): popen() failed' );
2712 $data = fread( $h, 8192 );
2713 if ( strlen( $data ) == 0 ) {
2721 unlink( $oldtextName );
2722 unlink( $newtextName );
2724 // Kill the --- and +++ lines. They're not useful.
2725 $diff_lines = explode( "\n", $diff );
2726 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2727 unset( $diff_lines[0] );
2729 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2730 unset( $diff_lines[1] );
2733 $diff = implode( "\n", $diff_lines );
2739 * This function works like "use VERSION" in Perl, the program will die with a
2740 * backtrace if the current version of PHP is less than the version provided
2742 * This is useful for extensions which due to their nature are not kept in sync
2743 * with releases, and might depend on other versions of PHP than the main code
2745 * Note: PHP might die due to parsing errors in some cases before it ever
2746 * manages to call this function, such is life
2748 * @see perldoc -f use
2750 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2751 * @throws MWException
2753 function wfUsePHP( $req_ver ) {
2754 $php_ver = PHP_VERSION
;
2756 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2757 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2762 * This function works like "use VERSION" in Perl except it checks the version
2763 * of MediaWiki, the program will die with a backtrace if the current version
2764 * of MediaWiki is less than the version provided.
2766 * This is useful for extensions which due to their nature are not kept in sync
2769 * Note: Due to the behavior of PHP's version_compare() which is used in this
2770 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2771 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2772 * targeted version number. For example if you wanted to allow any variation
2773 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2774 * not result in the same comparison due to the internal logic of
2775 * version_compare().
2777 * @see perldoc -f use
2779 * @deprecated since 1.26, use the "requires' property of extension.json
2780 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2781 * @throws MWException
2783 function wfUseMW( $req_ver ) {
2786 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2787 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2792 * Return the final portion of a pathname.
2793 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2794 * https://bugs.php.net/bug.php?id=33898
2796 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2797 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2799 * @param string $path
2800 * @param string $suffix String to remove if present
2803 function wfBaseName( $path, $suffix = '' ) {
2804 if ( $suffix == '' ) {
2807 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2811 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2819 * Generate a relative path name to the given file.
2820 * May explode on non-matching case-insensitive paths,
2821 * funky symlinks, etc.
2823 * @param string $path Absolute destination path including target filename
2824 * @param string $from Absolute source path, directory only
2827 function wfRelativePath( $path, $from ) {
2828 // Normalize mixed input on Windows...
2829 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2830 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2832 // Trim trailing slashes -- fix for drive root
2833 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2834 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2836 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2837 $against = explode( DIRECTORY_SEPARATOR
, $from );
2839 if ( $pieces[0] !== $against[0] ) {
2840 // Non-matching Windows drive letters?
2841 // Return a full path.
2845 // Trim off common prefix
2846 while ( count( $pieces ) && count( $against )
2847 && $pieces[0] == $against[0] ) {
2848 array_shift( $pieces );
2849 array_shift( $against );
2852 // relative dots to bump us to the parent
2853 while ( count( $against ) ) {
2854 array_unshift( $pieces, '..' );
2855 array_shift( $against );
2858 array_push( $pieces, wfBaseName( $path ) );
2860 return implode( DIRECTORY_SEPARATOR
, $pieces );
2864 * Convert an arbitrarily-long digit string from one numeric base
2865 * to another, optionally zero-padding to a minimum column width.
2867 * Supports base 2 through 36; digit values 10-36 are represented
2868 * as lowercase letters a-z. Input is case-insensitive.
2870 * @deprecated since 1.27 Use Wikimedia\base_convert() directly
2872 * @param string $input Input number
2873 * @param int $sourceBase Base of the input number
2874 * @param int $destBase Desired base of the output
2875 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2876 * @param bool $lowercase Whether to output in lowercase or uppercase
2877 * @param string $engine Either "gmp", "bcmath", or "php"
2878 * @return string|bool The output number as a string, or false on error
2880 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2881 $lowercase = true, $engine = 'auto'
2883 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2887 * @deprecated since 1.27, PHP's session generation isn't used with
2888 * MediaWiki\Session\SessionManager
2890 function wfFixSessionID() {
2891 wfDeprecated( __FUNCTION__
, '1.27' );
2895 * Reset the session id
2897 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2900 function wfResetSessionID() {
2901 wfDeprecated( __FUNCTION__
, '1.27' );
2902 $session = SessionManager
::getGlobalSession();
2903 $delay = $session->delaySave();
2905 $session->resetId();
2907 // Make sure a session is started, since that's what the old
2908 // wfResetSessionID() did.
2909 if ( session_id() !== $session->getId() ) {
2910 wfSetupSession( $session->getId() );
2913 ScopedCallback
::consume( $delay );
2917 * Initialise php session
2919 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2920 * Generally, "using" SessionManager will be calling ->getSessionById() or
2921 * ::getGlobalSession() (depending on whether you were passing $sessionId
2922 * here), then calling $session->persist().
2923 * @param bool|string $sessionId
2925 function wfSetupSession( $sessionId = false ) {
2926 wfDeprecated( __FUNCTION__
, '1.27' );
2929 session_id( $sessionId );
2932 $session = SessionManager
::getGlobalSession();
2933 $session->persist();
2935 if ( session_id() !== $session->getId() ) {
2936 session_id( $session->getId() );
2938 MediaWiki\
quietCall( 'session_start' );
2942 * Get an object from the precompiled serialized directory
2944 * @param string $name
2945 * @return mixed The variable on success, false on failure
2947 function wfGetPrecompiledData( $name ) {
2950 $file = "$IP/serialized/$name";
2951 if ( file_exists( $file ) ) {
2952 $blob = file_get_contents( $file );
2954 return unserialize( $blob );
2961 * Make a cache key for the local wiki.
2963 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2964 * @param string $args,...
2967 function wfMemcKey( /*...*/ ) {
2968 return call_user_func_array(
2969 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
2975 * Make a cache key for a foreign DB.
2977 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2980 * @param string $prefix
2981 * @param string $args,...
2984 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2985 $args = array_slice( func_get_args(), 2 );
2986 $keyspace = $prefix ?
"$db-$prefix" : $db;
2987 return call_user_func_array(
2988 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
2989 [ $keyspace, $args ]
2994 * Make a cache key with database-agnostic prefix.
2996 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2997 * instead. Must have a prefix as otherwise keys that use a database name
2998 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
3000 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
3002 * @param string $args,...
3005 function wfGlobalCacheKey( /*...*/ ) {
3006 return call_user_func_array(
3007 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
3013 * Get an ASCII string identifying this wiki
3014 * This is used as a prefix in memcached keys
3018 function wfWikiID() {
3019 global $wgDBprefix, $wgDBname;
3020 if ( $wgDBprefix ) {
3021 return "$wgDBname-$wgDBprefix";
3028 * Split a wiki ID into DB name and table prefix
3030 * @param string $wiki
3034 function wfSplitWikiID( $wiki ) {
3035 $bits = explode( '-', $wiki, 2 );
3036 if ( count( $bits ) < 2 ) {
3043 * Get a Database object.
3045 * @param int $db Index of the connection to get. May be DB_MASTER for the
3046 * master (for write queries), DB_REPLICA for potentially lagged read
3047 * queries, or an integer >= 0 for a particular server.
3049 * @param string|string[] $groups Query groups. An array of group names that this query
3050 * belongs to. May contain a single string if the query is only
3053 * @param string|bool $wiki The wiki ID, or false for the current wiki
3055 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
3056 * will always return the same object, unless the underlying connection or load
3057 * balancer is manually destroyed.
3059 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3060 * updater to ensure that a proper database is being updated.
3062 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
3063 * on an injected instance of LoadBalancer.
3065 * @return \Wikimedia\Rdbms\Database
3067 function wfGetDB( $db, $groups = [], $wiki = false ) {
3068 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3072 * Get a load balancer object.
3074 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
3075 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
3077 * @param string|bool $wiki Wiki ID, or false for the current wiki
3078 * @return \Wikimedia\Rdbms\LoadBalancer
3080 function wfGetLB( $wiki = false ) {
3081 if ( $wiki === false ) {
3082 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
3084 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3085 return $factory->getMainLB( $wiki );
3090 * Get the load balancer factory object
3092 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
3094 * @return \Wikimedia\Rdbms\LBFactory
3096 function wfGetLBFactory() {
3097 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3102 * Shortcut for RepoGroup::singleton()->findFile()
3104 * @param string $title String or Title object
3105 * @param array $options Associative array of options (see RepoGroup::findFile)
3106 * @return File|bool File, or false if the file does not exist
3108 function wfFindFile( $title, $options = [] ) {
3109 return RepoGroup
::singleton()->findFile( $title, $options );
3113 * Get an object referring to a locally registered file.
3114 * Returns a valid placeholder object if the file does not exist.
3116 * @param Title|string $title
3117 * @return LocalFile|null A File, or null if passed an invalid Title
3119 function wfLocalFile( $title ) {
3120 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3124 * Should low-performance queries be disabled?
3127 * @codeCoverageIgnore
3129 function wfQueriesMustScale() {
3130 global $wgMiserMode;
3132 ||
( SiteStats
::pages() > 100000
3133 && SiteStats
::edits() > 1000000
3134 && SiteStats
::users() > 10000 );
3138 * Get the path to a specified script file, respecting file
3139 * extensions; this is a wrapper around $wgScriptPath etc.
3140 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3142 * @param string $script Script filename, sans extension
3145 function wfScript( $script = 'index' ) {
3146 global $wgScriptPath, $wgScript, $wgLoadScript;
3147 if ( $script === 'index' ) {
3149 } elseif ( $script === 'load' ) {
3150 return $wgLoadScript;
3152 return "{$wgScriptPath}/{$script}.php";
3157 * Get the script URL.
3159 * @return string Script URL
3161 function wfGetScriptUrl() {
3162 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3163 /* as it was called, minus the query string.
3165 * Some sites use Apache rewrite rules to handle subdomains,
3166 * and have PHP set up in a weird way that causes PHP_SELF
3167 * to contain the rewritten URL instead of the one that the
3168 * outside world sees.
3170 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3171 * provides containing the "before" URL.
3173 return $_SERVER['SCRIPT_NAME'];
3175 return $_SERVER['URL'];
3180 * Convenience function converts boolean values into "true"
3181 * or "false" (string) values
3183 * @param bool $value
3186 function wfBoolToStr( $value ) {
3187 return $value ?
'true' : 'false';
3191 * Get a platform-independent path to the null file, e.g. /dev/null
3195 function wfGetNull() {
3196 return wfIsWindows() ?
'NUL' : '/dev/null';
3200 * Waits for the replica DBs to catch up to the master position
3202 * Use this when updating very large numbers of rows, as in maintenance scripts,
3203 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
3205 * By default this waits on the main DB cluster of the current wiki.
3206 * If $cluster is set to "*" it will wait on all DB clusters, including
3207 * external ones. If the lag being waiting on is caused by the code that
3208 * does this check, it makes since to use $ifWritesSince, particularly if
3209 * cluster is "*", to avoid excess overhead.
3211 * Never call this function after a big DB write that is still in a transaction.
3212 * This only makes sense after the possible lag inducing changes were committed.
3214 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3215 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3216 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3217 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3218 * @return bool Success (able to connect and no timeouts reached)
3219 * @deprecated since 1.27 Use LBFactory::waitForReplication
3221 function wfWaitForSlaves(
3222 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3224 if ( $timeout === null ) {
3225 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3228 if ( $cluster === '*' ) {
3231 } elseif ( $wiki === false ) {
3236 wfGetLBFactory()->waitForReplication( [
3238 'cluster' => $cluster,
3239 'timeout' => $timeout,
3240 // B/C: first argument used to be "max seconds of lag"; ignore such values
3241 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3243 } catch ( DBReplicationWaitError
$e ) {
3251 * Count down from $seconds to zero on the terminal, with a one-second pause
3252 * between showing each number. For use in command-line scripts.
3254 * @codeCoverageIgnore
3255 * @param int $seconds
3257 function wfCountDown( $seconds ) {
3258 for ( $i = $seconds; $i >= 0; $i-- ) {
3259 if ( $i != $seconds ) {
3260 echo str_repeat( "\x08", strlen( $i +
1 ) );
3272 * Replace all invalid characters with '-'.
3273 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
3274 * By default, $wgIllegalFileChars includes ':', '/', '\'.
3276 * @param string $name Filename to process
3279 function wfStripIllegalFilenameChars( $name ) {
3280 global $wgIllegalFileChars;
3281 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3282 $name = preg_replace(
3283 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3287 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3288 $name = wfBaseName( $name );
3293 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3295 * @return int Resulting value of the memory limit.
3297 function wfMemoryLimit() {
3298 global $wgMemoryLimit;
3299 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3300 if ( $memlimit != -1 ) {
3301 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3302 if ( $conflimit == -1 ) {
3303 wfDebug( "Removing PHP's memory limit\n" );
3304 MediaWiki\
suppressWarnings();
3305 ini_set( 'memory_limit', $conflimit );
3306 MediaWiki\restoreWarnings
();
3308 } elseif ( $conflimit > $memlimit ) {
3309 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3310 MediaWiki\
suppressWarnings();
3311 ini_set( 'memory_limit', $conflimit );
3312 MediaWiki\restoreWarnings
();
3320 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3322 * @return int Prior time limit
3325 function wfTransactionalTimeLimit() {
3326 global $wgTransactionalTimeLimit;
3328 $timeLimit = ini_get( 'max_execution_time' );
3329 // Note that CLI scripts use 0
3330 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3331 set_time_limit( $wgTransactionalTimeLimit );
3334 ignore_user_abort( true ); // ignore client disconnects
3340 * Converts shorthand byte notation to integer form
3342 * @param string $string
3343 * @param int $default Returned if $string is empty
3346 function wfShorthandToInteger( $string = '', $default = -1 ) {
3347 $string = trim( $string );
3348 if ( $string === '' ) {
3351 $last = $string[strlen( $string ) - 1];
3352 $val = intval( $string );
3357 // break intentionally missing
3361 // break intentionally missing
3371 * Get the normalised IETF language tag
3372 * See unit test for examples.
3374 * @param string $code The language code.
3375 * @return string The language code which complying with BCP 47 standards.
3377 function wfBCP47( $code ) {
3378 $codeSegment = explode( '-', $code );
3380 foreach ( $codeSegment as $segNo => $seg ) {
3381 // when previous segment is x, it is a private segment and should be lc
3382 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3383 $codeBCP[$segNo] = strtolower( $seg );
3384 // ISO 3166 country code
3385 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3386 $codeBCP[$segNo] = strtoupper( $seg );
3387 // ISO 15924 script code
3388 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3389 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3390 // Use lowercase for other cases
3392 $codeBCP[$segNo] = strtolower( $seg );
3395 $langCode = implode( '-', $codeBCP );
3400 * Get a specific cache object.
3402 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3405 function wfGetCache( $cacheType ) {
3406 return ObjectCache
::getInstance( $cacheType );
3410 * Get the main cache object
3414 function wfGetMainCache() {
3415 global $wgMainCacheType;
3416 return ObjectCache
::getInstance( $wgMainCacheType );
3420 * Get the cache object used by the message cache
3424 function wfGetMessageCacheStorage() {
3425 global $wgMessageCacheType;
3426 return ObjectCache
::getInstance( $wgMessageCacheType );
3430 * Get the cache object used by the parser cache
3434 function wfGetParserCacheStorage() {
3435 global $wgParserCacheType;
3436 return ObjectCache
::getInstance( $wgParserCacheType );
3440 * Call hook functions defined in $wgHooks
3442 * @param string $event Event name
3443 * @param array $args Parameters passed to hook functions
3444 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3446 * @return bool True if no handler aborted the hook
3447 * @deprecated since 1.25 - use Hooks::run
3449 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3450 return Hooks
::run( $event, $args, $deprecatedVersion );
3454 * Wrapper around php's unpack.
3456 * @param string $format The format string (See php's docs)
3457 * @param string $data A binary string of binary data
3458 * @param int|bool $length The minimum length of $data or false. This is to
3459 * prevent reading beyond the end of $data. false to disable the check.
3461 * Also be careful when using this function to read unsigned 32 bit integer
3462 * because php might make it negative.
3464 * @throws MWException If $data not long enough, or if unpack fails
3465 * @return array Associative array of the extracted data
3467 function wfUnpack( $format, $data, $length = false ) {
3468 if ( $length !== false ) {
3469 $realLen = strlen( $data );
3470 if ( $realLen < $length ) {
3471 throw new MWException( "Tried to use wfUnpack on a "
3472 . "string of length $realLen, but needed one "
3473 . "of at least length $length."
3478 MediaWiki\
suppressWarnings();
3479 $result = unpack( $format, $data );
3480 MediaWiki\restoreWarnings
();
3482 if ( $result === false ) {
3483 // If it cannot extract the packed data.
3484 throw new MWException( "unpack could not unpack binary data" );
3490 * Determine if an image exists on the 'bad image list'.
3492 * The format of MediaWiki:Bad_image_list is as follows:
3493 * * Only list items (lines starting with "*") are considered
3494 * * The first link on a line must be a link to a bad image
3495 * * Any subsequent links on the same line are considered to be exceptions,
3496 * i.e. articles where the image may occur inline.
3498 * @param string $name The image name to check
3499 * @param Title|bool $contextTitle The page on which the image occurs, if known
3500 * @param string $blacklist Wikitext of a file blacklist
3503 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3504 # Handle redirects; callers almost always hit wfFindFile() anyway,
3505 # so just use that method because it has a fast process cache.
3506 $file = wfFindFile( $name ); // get the final name
3507 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3509 # Run the extension hook
3511 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3515 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3516 $key = $cache->makeKey(
3517 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3519 $badImages = $cache->get( $key );
3521 if ( $badImages === false ) { // cache miss
3522 if ( $blacklist === null ) {
3523 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3525 # Build the list now
3527 $lines = explode( "\n", $blacklist );
3528 foreach ( $lines as $line ) {
3530 if ( substr( $line, 0, 1 ) !== '*' ) {
3536 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3541 $imageDBkey = false;
3542 foreach ( $m[1] as $i => $titleText ) {
3543 $title = Title
::newFromText( $titleText );
3544 if ( !is_null( $title ) ) {
3546 $imageDBkey = $title->getDBkey();
3548 $exceptions[$title->getPrefixedDBkey()] = true;
3553 if ( $imageDBkey !== false ) {
3554 $badImages[$imageDBkey] = $exceptions;
3557 $cache->set( $key, $badImages, 60 );
3560 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3561 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3567 * Determine whether the client at a given source IP is likely to be able to
3568 * access the wiki via HTTPS.
3570 * @param string $ip The IPv4/6 address in the normal human-readable form
3573 function wfCanIPUseHTTPS( $ip ) {
3575 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3580 * Determine input string is represents as infinity
3582 * @param string $str The string to determine
3586 function wfIsInfinity( $str ) {
3587 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3588 return in_array( $str, $infinityValues );
3592 * Returns true if these thumbnail parameters match one that MediaWiki
3593 * requests from file description pages and/or parser output.
3595 * $params is considered non-standard if they involve a non-standard
3596 * width or any non-default parameters aside from width and page number.
3597 * The number of possible files with standard parameters is far less than
3598 * that of all combinations; rate-limiting for them can thus be more generious.
3601 * @param array $params
3603 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3605 function wfThumbIsStandard( File
$file, array $params ) {
3606 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3608 $multipliers = [ 1 ];
3609 if ( $wgResponsiveImages ) {
3610 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3611 // @see Linker::processResponsiveImages
3612 $multipliers[] = 1.5;
3616 $handler = $file->getHandler();
3617 if ( !$handler ||
!isset( $params['width'] ) ) {
3622 if ( isset( $params['page'] ) ) {
3623 $basicParams['page'] = $params['page'];
3628 // Expand limits to account for multipliers
3629 foreach ( $multipliers as $multiplier ) {
3630 $thumbLimits = array_merge( $thumbLimits, array_map(
3631 function ( $width ) use ( $multiplier ) {
3632 return round( $width * $multiplier );
3635 $imageLimits = array_merge( $imageLimits, array_map(
3636 function ( $pair ) use ( $multiplier ) {
3638 round( $pair[0] * $multiplier ),
3639 round( $pair[1] * $multiplier ),
3645 // Check if the width matches one of $wgThumbLimits
3646 if ( in_array( $params['width'], $thumbLimits ) ) {
3647 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3648 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3649 $handler->normaliseParams( $file, $normalParams );
3651 // If not, then check if the width matchs one of $wgImageLimits
3653 foreach ( $imageLimits as $pair ) {
3654 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3655 // Decide whether the thumbnail should be scaled on width or height.
3656 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3657 $handler->normaliseParams( $file, $normalParams );
3658 // Check if this standard thumbnail size maps to the given width
3659 if ( $normalParams['width'] == $params['width'] ) {
3665 return false; // not standard for description pages
3669 // Check that the given values for non-page, non-width, params are just defaults
3670 foreach ( $params as $key => $value ) {
3671 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3680 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3682 * Values that exist in both values will be combined with += (all values of the array
3683 * of $newValues will be added to the values of the array of $baseArray, while values,
3684 * that exists in both, the value of $baseArray will be used).
3686 * @param array $baseArray The array where you want to add the values of $newValues to
3687 * @param array $newValues An array with new values
3688 * @return array The combined array
3691 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3692 // First merge items that are in both arrays
3693 foreach ( $baseArray as $name => &$groupVal ) {
3694 if ( isset( $newValues[$name] ) ) {
3695 $groupVal +
= $newValues[$name];
3698 // Now add items that didn't exist yet
3699 $baseArray +
= $newValues;